<?php ob_start('ob_gzhandler') ?>
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <!--
        /**
        * o------------------------------------------------------------------------------o
        * | This file is part of the RGraph package - you can learn more at:             |
        * |                                                                              |
        * |                          http://www.rgraph.net                               |
        * |                                                                              |
        * | This package is licensed under the RGraph license. For all kinds of business |
        * | purposes there is a small one-time licensing fee to pay and for non          |
        * | commercial  purposes it is free to use. You can read the full license here:  |
        * |                                                                              |
        * |                      http://www.rgraph.net/LICENSE.txt                       |
        * o------------------------------------------------------------------------------o
        */
    -->
    <title>RGraph: HTML5 canvas graph library - Odometer documentation</title>
    <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
    <link rel="icon" type="image/png" href="/favicon.png">
</head>
<body>
    <div id="breadcrumb">
        <a href="../index.html">RGraph: HTML5 canvas graph library</a>
        >
        <a href="index.html">Documentation</a>
        >
        Odometer
    </div>

    <h1>RGraph: HTML5 canvas graph library - Odometer documentation</h1>

    <script>
        if (document.all) {
            document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer does not natively support the HTML5 canvas tag yet, so if you want to see the graphs, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the RGraph Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul></div>');
        }
    </script>
    
    <p> 
        The example file is <a href="../examples/odo.html">here</a>.
    </p> 
    
    <pre class="code">
&lt;script&gt;
    window.onload = function ()
    {
        // ID, MINIMUM, MAXIMUM, INDICATED VALUE
        var odo = new RGraph.Odometer('myOdo', 0, 100, 18);
        
        odo.Set('chart.green.max', 75);
        odo.Set('chart.red.min', 90);
        odo.Set('chart.label.space', 50);
        odo.Set('chart.needle.thickness', 2);
    
        odo.Draw();
    }
&lt;/script&gt;
</pre>

    <div class="warning">
        <p>Note</p>
         As of 20th March 2010, how you specify the start and end values has changed. The chart.green.start, chart.green.end, chart.yellow.start,
         chart.yellow.end, chart.red.start and chart.red.end have all been replaced by chart.green.max and chart.red.min. Now the
         green area always starts at zero and goes to chart.green.max, and the red area starts at 90% of the maximum value and
         goes to the maximum value. The yellow area is between the two.
    </div>

    <h2>Available properties</h2>
    
    <p>
        You can use these properties to control how the bar graph apears. You can set these properties using the <b>Set()</b> method.
    </p>
    
    <!--
        <PROPERTIES>
            chart.gutter :: The width of the area outside the odometer. <br /><i>Default: 25</i>
            chart.green.max :: This is the point at which the green area ends.<br /><i>Default: 75% of the maximum value</i>
            chart.red.min :: This is the point at which the red area starts. The yellow area is between the green and red areas.<br /> <i>Default: 90% of the maximum value</i>
            chart.label.area :: The width of the area that labels are put in. <br /><i>Default: 35</i>
            chart.needle.thickness :: How thick the needle is. <br /><i>Default: 2</i>
            chart.needle.style :: The style that is applied to the needle. <br /><i>Default: #000</i>
            chart.needle.head :: This controls whether the arrow head on the end of the needle is displayed. <br /><i>Default: true</i>
            chart.title :: The title text. <br /><i>Default: no title set</i>
            chart.title.color :: The color of the title.<br /> <i>Default: black</i>
            chart.title.vpos :: This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i>
            chart.value :: The indicated value <br /><i>Default: none - must be given - also an argument to the constructor</i>
            chart.start :: The start value. <br /><i>Default: none - must be given - also an argument to the constructor</i>
            chart.end :: The end value. <br /><i>Default: none - must be given - also an argument to the constructor</i>
            chart.shadow.inner :: Whether a drop shadow is applied to the inner circle of the Odometer<br /><i>Default: false</i>
            chart.shadow.outer :: Whether a drop shadow is applied to the whole Odometer.<br /><i>Default: false</i>
            chart.text.size :: The size of the text (in points). <br /><i>Default: 10</i>
            chart.text.font :: The font used to render the text.<br /><i>Default: Verdana</i>
            chart.text.color :: The color of the labels. <br /><i>Default: black</i>
            chart.contextmenu :: An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i>
            chart.annotatable :: Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i>
            chart.annotate.color :: If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i>
            chart.zoom.mode :: Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i>
            chart.zoom.factor :: This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i>
            chart.zoom.fade.in :: Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.fade.out :: Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.hdir :: The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i>
            chart.zoom.vdir :: The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i>
            chart.zoom.delay :: The delay (in milliseconds) between frames.<br /><i>Default: 50</i>
            chart.zoom.frames :: The number of frames in the zoom animation.<br /><i>Default: 10</i>
            chart.zoom.shadow :: Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i>
            chart.zoom.thumbnail.width :: When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.thumbnail.height :: When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.background :: Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i>
        </PROPERTIES>
    -->
    
    <!-- DOCS -->

    <table border="0" id="docs">
        <tr>
            <th><a name="chart.gutter"></a>chart.gutter</th>
            <td>The width of the area outside the odometer. <br /><i>Default: 25</i></td>
            <th><a name="chart.green.max"></a>chart.green.max</th>
            <td>This is the point at which the green area ends.<br /><i>Default: 75% of the maximum value</i></td>
        </tr>
        <tr>
            <th><a name="chart.red.min"></a>chart.red.min</th>
            <td>This is the point at which the red area starts. The yellow area is between the green and red areas.<br /> <i>Default: 90% of the maximum value</i></td>
            <th><a name="chart.label.area"></a>chart.label.area</th>
            <td>The width of the area that labels are put in. <br /><i>Default: 35</i></td>
        </tr>
        <tr>
            <th><a name="chart.needle.thickness"></a>chart.needle.thickness</th>
            <td>How thick the needle is. <br /><i>Default: 2</i></td>
            <th><a name="chart.needle.style"></a>chart.needle.style</th>
            <td>The style that is applied to the needle. <br /><i>Default: #000</i></td>
        </tr>
        <tr>
            <th><a name="chart.needle.head"></a>chart.needle.head</th>
            <td>This controls whether the arrow head on the end of the needle is displayed. <br /><i>Default: true</i></td>
            <th><a name="chart.title"></a>chart.title</th>
            <td>The title text. <br /><i>Default: no title set</i></td>
        </tr>
        <tr>
            <th><a name="chart.title.color"></a>chart.title.color</th>
            <td>The color of the title.<br /> <i>Default: black</i></td>
            <th><a name="chart.title.vpos"></a>chart.title.vpos</th>
            <td>This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i></td>
        </tr>
        <tr>
            <th><a name="chart.value"></a>chart.value</th>
            <td>The indicated value <br /><i>Default: none - must be given - also an argument to the constructor</i></td>
            <th><a name="chart.start"></a>chart.start</th>
            <td>The start value. <br /><i>Default: none - must be given - also an argument to the constructor</i></td>
        </tr>
        <tr>
            <th><a name="chart.end"></a>chart.end</th>
            <td>The end value. <br /><i>Default: none - must be given - also an argument to the constructor</i></td>
            <th><a name="chart.shadow.inner"></a>chart.shadow.inner</th>
            <td>Whether a drop shadow is applied to the inner circle of the Odometer<br /><i>Default: false</i></td>
        </tr>
        <tr>
            <th><a name="chart.shadow.outer"></a>chart.shadow.outer</th>
            <td>Whether a drop shadow is applied to the whole Odometer.<br /><i>Default: false</i></td>
            <th><a name="chart.text.size"></a>chart.text.size</th>
            <td>The size of the text (in points). <br /><i>Default: 10</i></td>
        </tr>
        <tr>
            <th><a name="chart.text.font"></a>chart.text.font</th>
            <td>The font used to render the text.<br /><i>Default: Verdana</i></td>
            <th><a name="chart.text.color"></a>chart.text.color</th>
            <td>The color of the labels. <br /><i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.contextmenu"></a>chart.contextmenu</th>
            <td>An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i></td>
            <th><a name="chart.annotatable"></a>chart.annotatable</th>
            <td>Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i></td>
        </tr>
        <tr>
            <th><a name="chart.annotate.color"></a>chart.annotate.color</th>
            <td>If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i></td>
            <th><a name="chart.zoom.mode"></a>chart.zoom.mode</th>
            <td>Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.factor"></a>chart.zoom.factor</th>
            <td>This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i></td>
            <th><a name="chart.zoom.fade.in"></a>chart.zoom.fade.in</th>
            <td>Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.fade.out"></a>chart.zoom.fade.out</th>
            <td>Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
            <th><a name="chart.zoom.hdir"></a>chart.zoom.hdir</th>
            <td>The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.vdir"></a>chart.zoom.vdir</th>
            <td>The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i></td>
            <th><a name="chart.zoom.delay"></a>chart.zoom.delay</th>
            <td>The delay (in milliseconds) between frames.<br /><i>Default: 50</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.frames"></a>chart.zoom.frames</th>
            <td>The number of frames in the zoom animation.<br /><i>Default: 10</i></td>
            <th><a name="chart.zoom.shadow"></a>chart.zoom.shadow</th>
            <td>Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.thumbnail.width"></a>chart.zoom.thumbnail.width</th>
            <td>When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
            <th><a name="chart.zoom.thumbnail.height"></a>chart.zoom.thumbnail.height</th>
            <td>When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.background"></a>chart.zoom.background</th>
            <td>Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i></td>
        </tr>
    </table><br /><br />

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

</body>
</html>